/*
 * This file is part of the Sx Framework Library.
 * 
 * Copyright (C) 2013 University of Colorado Denver
 * <min.choi@ucdenver.edu>
 * <shane.transue@ucdenver.edu>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */
#ifndef SX_QCONSOLE_H
#define SX_QCONSOLE_H

#include <QPlainTextEdit>
#include <sxString.h>

namespace Sx {
namespace QtInterface {
namespace System {

class QDebugStream;

/*
 * The QPlainTextEdit is used for performance. The QTextEdit
 * class (which can utilize html) is extremely slow for logging
 * operations. The QPlainTextEdit can be modified to provide an
 * efficient log window and the text coloring can be provided
 * via a QSyntaxHighlighter.
 */
class QConsole : public QPlainTextEdit {
	Q_OBJECT

public:
	/*
	 * Creates a new logging Console. The parent is the owner of the window,
	 * the stream is the standard stream to redirect: std::cout, std::cerr
	 * and the logFilename is the name of the file in which the stream will
	 * be recorded.
	 */
	QConsole(QWidget* parent, std::ostream* stream = nullptr, const String& logFilename = "console.log");
	~QConsole();

	/*
	 * Moves the cursor of this text edit to the last line to show the most
	 * recently appended text.
	 */
	void setConsoleCursorToEnd();

	void setLogFilename(const String& filename);

	/*
	 * Sets the ostream that this console displays. When data is sent to the
	 * ostream it will be displayed by this console.
	 */
	bool setStream(std::ostream* stream);

public slots:
	/*
	 * For thread safety the text of this console should only be appended
	 * through the use of these slots with a Qt QueuedConnection. 
	 */
	void onAppend(const QString& text);
	void onLogAppend(const QString& text);
  
private:
	/*
	 * Debug stream that reroutes the provided ostream.
	 *
	 * Pointer Ownership: YES
	 */
	QDebugStream* debugStream;
};

}

}

}

#endif
